/*
 * Copyright 2008 Nordic Consulting & Development Company
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package pl.ncdc.web.login.client.service;

import pl.ncdc.web.login.client.User;

import com.google.gwt.user.client.rpc.RemoteService;

/**
 * User data retrieval service.
 * <p>
 * Created on Apr 17, 2008
 *
 * @author hshsce
 * @version $Id: UserService.java 103 2008-06-02 14:44:57Z hshsce $
 */
public interface UserService extends RemoteService {

	/**
	 * Lists available users.
	 *
	 * @return the list of available users.
	 */
	User[] list();

	/**
	 * Suggests possible user according to the given <code>query</code>.
	 * The query consists of the beginning letters of the <code>uid</code>.
	 *
	 * @param query the beginning letters of uid to query.
	 * @return the users which conform the <code>query</code>.
	 */
	String[] suggestUid(String query);

}
